Skip to content

First take on a comprehensive ingest guide #1373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 9 commits into from
Closed

First take on a comprehensive ingest guide #1373

wants to merge 9 commits into from

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Oct 7, 2024 •
edited
Loading

New take on ingest story.

  • Start by trying to answer the question we hear most: "What ingest option should I use?"
  • Start with basic use cases and expand to more advanced use cases.
  • Proposal: Get to MVP quickly, and continue to iterate.

PREVIEW: https://ingest-docs_bk_1373.docs-preview.app.elstc.co/guide/en/ingest/master/ingest-guide.html

Notes

  • I've placed the content at the end of Ingest Architectures temporarily so that we can build it and see previews. This is not intended as the final destination.

Related:

@karenzone karenzone self-assigned this Oct 7, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@mergify Mergify
Copy link
Contributor

mergify bot commented Oct 7, 2024

This pull request does not have a backport label. Could you fix it @karenzone? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip label Oct 7, 2024
karenzone
karenzone commented Oct 8, 2024
View reviewed changes
docs/en/ingest-guide/ingest-tools.asciidoc Outdated
@@ -0,0 +1,99 @@
[[ingest-tools]]
== Tools for ingesting data
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ordinarily, we wouldn't put forth a list of tools. Because we have quite a few ingest options and we highlight subsets throughout our doc sets, it seems helpful to list all ingest tools with descriptions in one place.

@karenzone karenzone changed the title DRAFT: First take on a comprehensive ingest guide First take on a comprehensive ingest guide Oct 29, 2024
@karenzone karenzone marked this pull request as ready for review October 29, 2024 21:45
@karenzone karenzone requested a review from a team as a code owner October 29, 2024 21:46
@karenzone
Copy link
Contributor Author

MVP proposal

This PR includes the elements that we decided were "must have" for an MVP:

  • Answer the most commonly asked question about ingesting data--"What's the best approach?"
    • Focus on starting basic, but making it clear up front that we can handle more complex scenarios if needed
  • Describe ingest options and when they should be used
  • Emphasize solutions, encouraging users to start with Agent and integrations.

Next iteration

Issue to capture feedback and ideas for next iteration: https://github.com/elastic/platform-docs-team/issues/545

@karenzone
Copy link
Contributor Author

karenzone commented Oct 29, 2024 •
edited
Loading

@kilfoyle @alaudazzi @mdbirnstiehl @georgewallace, thank you for your comments in the previous markup.io review.
Now that we're in the refinement stage, please add your feedback as github suggestions and comments.
And as always, please let me know if you'd like to discuss.

@karenzone karenzone mentioned this pull request Oct 30, 2024
Closed
13 tasks
@karenzone
Copy link
Contributor Author

run docs-build

@karenzone
Copy link
Contributor Author

run docs-build

@karenzone karenzone mentioned this pull request Jan 21, 2025
Merged
kilfoyle
kilfoyle approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀
Very nice! This seems a big improvement over our current landing page.

@karenzone
Copy link
Contributor Author

This PR was absorbed and replaced by #1644.
I'm leaving this PR open to preserve the preview.

We can't see previews on the content in #1644 until we make necessary changes to conf.yaml.

@karenzone karenzone mentioned this pull request Jan 29, 2025
Closed
@karenzone
Copy link
Contributor Author

Closing now that #1644 is merged.

@karenzone karenzone closed this Jan 29, 2025
@karenzone karenzone deleted the 489-ingest-x branch January 29, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kilfoyle kilfoyle kilfoyle approved these changes

@georgewallace georgewallace Awaiting requested review from georgewallace

@alaudazzi alaudazzi Awaiting requested review from alaudazzi

@mdbirnstiehl mdbirnstiehl Awaiting requested review from mdbirnstiehl

Assignees

@karenzone karenzone

Labels

backport-skip

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@karenzone @kilfoyle